Skip to main content

Usage Command

Download DEVLENS​

DEVLENS is available in the release section of the documentation repository:

https://github.com/soma-smart/doc-devlens/releases

When you extract DEVLENS, be sure to get the ANNOTATORS FOLDER unless you have your own.

download

Interactive mode​

DEVLENS provides an easy and accessible Interactive mode that will give you a cool step-by-step UI in the terminal to do everything you need.

To launch the interactive mode, use the --interactive flag:

./devlens --interactive

interactive

Command mode​

DEVLENS also comes in "command" mode where you can use flags to launch various commands:

To see the command mode you can simply execute:

./devlens

basic

Local Check​

./devlens check yourfolder/

Local Check + Kubernetes secrets​

./devlens check yourfolder/ \
--deployment-file yourdeploymentfilepath \
--kubeconfig yourkubeconfigpath

Dataiku Check​

./devlens --dataiku-instance yourdataikuinstancename \
--dataiku-project-key yourdataikuprojectkey

Dataiku download locally your project​

./devlens --dataiku-instance yourdataikuinstancename \
--dataiku-project-key yourdataikuprojectkey \
--project-file-download

Query​

./devlens query "SELECT ..."

Replace​

./devlens replace yourpath/ 
--query "SELECT * FROM ..." \
--replace-type yourtype \
--replace-logic yourlogic \
  • path: The path to the directory or file to analyze and perform replacements.
  • --query: The SQL query to select the annotations to replace.
  • --replace-type: The type of replacement to perform. Options are:
    • simple: Perform a straightforward string replacement.
    • logic: Perform a replacement based on SQL logic.
  • --replace-pattern: The pattern to search for in simple replacements.
  • --replace-value: The value to replace the pattern with in simple replacements.
  • --replace-logic: The SQL logic for dynamic replacements.

Make DEVLENS globally available​

If you want to use devlens anywhere on your machine, you might want to make it available globally:

sudo mv ./devlens /usr/local/bin/
sudo chmod +x /usr/local/bin/devlens